<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>trafgen: xtrafgen_interrupt_example.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">trafgen
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xtrafgen__interrupt__example_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xtrafgen_interrupt_example.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file demonstrates how to use the xtrafgen driver on the Xilinx AXI Traffic Generator core. </p>
<p>The AXI Traffic Generator IP is designed to generate AXI4 traffic which can be used to stress different modules/ interconnect connected in the system. It has three internal RAMS: MASTER RAM, COMMAND RAM, PARAMETER RAM. MASTER RAM is used to load/store data from this memory for write/read transactions. And the commands to be issued are loaded into COMMAND and PARAMETER RAMs.</p>
<p>This example demonstrates by programming known data to Master RAM and commands to Command and Param RAM. Initiating the master logic will take the data from Master RAM (from a location) and generate data for slave transactions which will be stored in Master RAM at a different location specified by commands. The test passes when the master logic interrupt asserts and verifies for data to be same.</p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who  Date     Changes
----- ---- -------- -------------------------------------------------------
1.00a srt  01/25/13 First release
4.1   ms   01/23/17 Modified xil_printf statement in main function to
                    ensure that "Successfully ran" and "Failed" strings
                    are available in all examples. This is a fix for
                    CR-965028.
      ms   04/05/17 Added tabspace for return statements in functions for
                    proper documentation while generating doxygen.
4.5   sd   07/18/23 Fix the disable interrupt
4.7   ar   03/07/24 Fix the interrupt ID sequence in the SDT flow.
</pre><hr/>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:afb79fd728f1a6cb5493de055332e83a6"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtrafgen__interrupt__example_8c.html#afb79fd728f1a6cb5493de055332e83a6">XTrafGenInterruptExample</a> (<a class="el" href="struct_x_traf_gen.html">XTrafGen</a> *InstancePtr, u16 DeviceId)</td></tr>
<tr class="memdesc:afb79fd728f1a6cb5493de055332e83a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function demonstrates the usage Traffic Generator It does the following:  <a href="#afb79fd728f1a6cb5493de055332e83a6">More...</a><br/></td></tr>
<tr class="separator:afb79fd728f1a6cb5493de055332e83a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtrafgen__interrupt__example_8c.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a> ()</td></tr>
<tr class="memdesc:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main function.  <a href="#ae66f6b31b5ad750f1fe042a706a4e3d4">More...</a><br/></td></tr>
<tr class="separator:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ae66f6b31b5ad750f1fe042a706a4e3d4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int main </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Main function. </p>
<p>This function is the main entry of the traffic generator test.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">None</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if tests pass<ul>
<li>XST_FAILURE if fails.</li>
</ul>
</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None </dd></dl>

<p>References <a class="el" href="xtrafgen__interrupt__example_8c.html#afb79fd728f1a6cb5493de055332e83a6">XTrafGenInterruptExample()</a>.</p>

</div>
</div>
<a class="anchor" id="afb79fd728f1a6cb5493de055332e83a6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XTrafGenInterruptExample </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_traf_gen.html">XTrafGen</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>DeviceId</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function demonstrates the usage Traffic Generator It does the following: </p>
<pre class="fragment">  - Set up the output terminal if UART16550 is in the hardware build
  - Initialize the AXI Traffic Generator device
  - Initialize Master RAM
  - Initialize commands and add them to list
  - Program internal command and parameter RAMs
  - Start Master Logic
  - Wait for the master logic to finish
  - Check for errors
  - Read Master RAM and verify data
  - Return test status and exit
</pre><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the instance of the <a class="el" href="struct_x_traf_gen.html" title="The XTrafGen driver instance data. ">XTrafGen</a> component. </td></tr>
    <tr><td class="paramname">DeviceId</td><td>is Device ID of the Axi Traffic Generator Device, typically XPAR_&lt;TRAFGEN_instance&gt;_DEVICE_ID value from xparameters.h.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>-XST_SUCCESS to indicate success -XST_FAILURE to indicate failure </dd></dl>

<p>References <a class="el" href="struct_x_traf_gen___c_ram_cmd.html#ae9889d89710989823d3b633effbe20ca">XTrafGen_CRamCmd::Address</a>, <a class="el" href="struct_x_traf_gen___config.html#ac47f34b47fc9fb39c04ac7a57ac58d48">XTrafGen_Config::BaseAddress</a>, <a class="el" href="struct_x_traf_gen.html#a201c38f1c1aee1167972954d71b2e013">XTrafGen::Config</a>, <a class="el" href="struct_x_traf_gen___cmd.html#ad9231ba1f718b9a9511f1a3ea863bca1">XTrafGen_Cmd::CRamCmd</a>, <a class="el" href="group__trafgen.html#ga84a7f675e8ab79a86daedc6abd01fbec">ERROR_INTRID</a>, <a class="el" href="struct_x_traf_gen___c_ram_cmd.html#a06f887cc537f2323df21f09da24cf279">XTrafGen_CRamCmd::Length</a>, <a class="el" href="group__trafgen.html#gade5e5059c5f95eacc3caec6096ddf384">MASTER_INTRID</a>, <a class="el" href="struct_x_traf_gen___c_ram_cmd.html#a1597162b77eff37a19cf257102acaba4">XTrafGen_CRamCmd::MasterRamIndex</a>, <a class="el" href="struct_x_traf_gen___c_ram_cmd.html#a5c786c1362dc5fd6319567d4ec86d19e">XTrafGen_CRamCmd::MyDepend</a>, <a class="el" href="struct_x_traf_gen___c_ram_cmd.html#a044d212e3fbbfa62d31d66f0ca7b616c">XTrafGen_CRamCmd::OtherDepend</a>, <a class="el" href="struct_x_traf_gen___cmd.html#a6c452068b7aac042b11056897c6da2c7">XTrafGen_Cmd::RdWrFlag</a>, <a class="el" href="struct_x_traf_gen___c_ram_cmd.html#a1cf9795d88ebae2b9c9ca42c677c862b">XTrafGen_CRamCmd::Size</a>, <a class="el" href="struct_x_traf_gen___c_ram_cmd.html#a197e871656f2931f5c4c0e6c366ed7cb">XTrafGen_CRamCmd::ValidCmd</a>, <a class="el" href="group__trafgen.html#ga2391f0c6f6705906f85e0da3d16e3222">XTG_READ</a>, <a class="el" href="group__trafgen.html#ga8a676092267b72a3e5ad91718b914ecf">XTG_WRITE</a>, <a class="el" href="group__trafgen.html#gaaea625b89454268bbbe7f93e309141c4">XTrafGen_AccessMasterRam()</a>, <a class="el" href="group__trafgen.html#ga39eaea669c1ff2df58e54c002b43f854">XTrafGen_AddCommand()</a>, <a class="el" href="group__trafgen.html#ga4d40f6d5551836dab49e0d22e8d5e1eb">XTrafGen_CfgInitialize()</a>, <a class="el" href="group__trafgen.html#ga11a588bff0d2c58310d48da4c24126a1">XTrafGen_EnableMasterCmpInterrupt</a>, <a class="el" href="group__trafgen.html#ga262d850cbfc5b0495fbc2d84334a1fba">XTrafGen_GetLastValidIndex()</a>, <a class="el" href="group__trafgen.html#gacbf906e378777e17e7d68729315993ec">XTrafGen_LookupConfig()</a>, <a class="el" href="group__trafgen.html#gad9654a81e902175a963c83edb0c37144">XTrafGen_PrintCmds()</a>, <a class="el" href="group__trafgen.html#gaf55f0066544c5ca956f2775e2927851d">XTrafGen_StartMasterLogic</a>, and <a class="el" href="group__trafgen.html#ga14377a8884e99ce01c0c76128c939c49">XTrafGen_WriteCmdsToHw()</a>.</p>

<p>Referenced by <a class="el" href="xtrafgen__interrupt__example_8c.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
